home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 013 / auto20.arc / AUTOMENU.DOC < prev    next >
Encoding:
Text File  |  1984-10-15  |  16.7 KB  |  337 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.                +----------------------------------------------------+
  12.                |                   AUTOMENU  2.0                    |
  13.                | (C)1983       by Marshall W. Magee       10/01/84  |
  14.                +----------------------------------------------------+
  15.  
  16.  
  17.  
  18.  
  19.  
  20.     ===========================================================================
  21.                                   COPY NOTICE
  22.  
  23.          This software is user-supported software and can be freely copied and
  24.     used by anyone who wishes to do so.  The rights to commercially market this
  25.     software remain with the programmer.  If you feel this program has
  26.     benefited you, the programmer will accept any unsolicited donations of
  27.     twenty-five dollars.  The source code for this software is written in
  28.     assembler language and a printed copy can be obtained directly.  Any
  29.     comments concerning AUTOMENU would be greatly appreciated.  Also send a
  30.     postcard, without obligation, to register for notices of updates.  Please
  31.     use the address below.  A copy of this message can be obtained by pressing
  32.     "C" while in the AUTOMENU program.  Updates and other neat programs will be
  33.     available in the future.  Please support the free enterprise system.  Thank
  34.     you!
  35.  
  36.                         MAGEE ENTERPRISES
  37.                         6577 Peachtree Industrial Blvd.
  38.                         Norcross, Georgia  30092-3796
  39.     ===========================================================================
  40.  
  41.  
  42.                            FILES BELONGING TO AUTOMENU
  43.         +-------------+
  44.         |AUTOMENU COM | <- Main AUTOMENU program
  45.         |AUTOMENU DAT | <- Data file with menu items contained
  46.         |AUTO     BAT | <- Batch file to call AUTOMENU
  47.         |AUTOMENU DOC | <- Documentation for AUTOMENU
  48.         |AUTOTEMP BAT | <- Temporary batch file written by AUTOMENU
  49.         |AUTO1    BAT | <- Version of batch file "AUTO.BAT" for DOS 1
  50.         |AUTO2    BAT | <- Version of batch file "AUTO.BAT" for DOS 2
  51.         +-------------+
  52. î                                                                        Page 2
  53.                                    INTRODUCTION
  54.  
  55.          AUTOMENU is the solution to the problem of learning the all the DOS
  56.     commands required to access many different application programs.  No longer
  57.     will the user be required to type in a list of commands to find the program
  58.     they are looking for; with a single press of a key, almost any application
  59.     program can be made available.  AUTOMENU provides the user with an easy to
  60.     read and understand menu of options to choose from, then automatically
  61.     executes the commands required to bring that menu option selected to the
  62.     user's fingertips.  AUTOMENU provides the user with the capability to set
  63.     up their own customized menu systems.  The user can define the menu titles,
  64.     the menu options displayed, and DOS compatible commands required to carry
  65.     out each of these menu options.
  66.  
  67.                                    FEATURES
  68.  
  69.         *  Ability to define eight individual menus per menu file
  70.         *  Eight menu options per menu
  71.         *  Individually titled menus, automatically centered
  72.         *  Compatible with floppy disk or fixed disk systems
  73.         *  Program requires only 8,000 bytes to store on disk
  74.         *  Fast assembler language program
  75.         *  Help Messages
  76.         *  Automatic Screen Blackout to save monitor
  77.         *  Option to switch from the color to monochrome monitor and back
  78.         *  Current date and time displayed while in menu
  79.         *  Amount of Memory Available displayed
  80.         *  Status of Keyboard displayed (Caps Lock, Num Lock, Scroll Lock)
  81.         *  Multiply keys perform the same functions for logical selection
  82.         *  Updates available
  83.         *  FREE!
  84.  
  85.                       HARDWARE AND SOFTWARE REQUIREMENTS
  86.  
  87.         These are the minimum requirements of AUTOMENU:
  88.  
  89.         *  Compatible machine or (PC,XT,PC Jr.,Portable)
  90.         *  DOS (1.1, 2.0, 2.1, 3.0)
  91.         *  Minimum of 30KB of free memory
  92.         *  Supports Monochrome and/or Color Monitors
  93.  
  94.                             HOW DOES AUTOMENU WORK
  95.  
  96.          The concept that makes AUTOMENU work is the facility provided by DOS,
  97.     called batch files.  A batch file contains a list of DOS commands that you
  98.     wish to be executed by entering one command.  A good example of a batch
  99.     file is AUTOEXEC.BAT.  This batch file is executed automatically by DOS at
  100.     boot time and should contain commands needed to be done the first time you
  101.     boot your system from DOS such as:  setting up a RAM disk or setting the
  102.     time from your clock card.
  103.  
  104.          AUTOMENU simply builds a batch file containing the commands required
  105.     to carry out the menu option selected.  The one batch file that is used to
  106.     make AUTOMENU active is called AUTO.BAT.  AUTO.BAT contains two commands;
  107.     the first is AUTOMENU, which executes the menu program, and the second is
  108.     AUTOTEMP, which is a batch file containing commands written to it by
  109.     AUTOMENU.  After selecting your desired menu option from the menu, AUTOMENU
  110.     creates AUTOTEMP.BAT which in turn is executed by AUTO.BAT.  AUTOTEMP.BAT
  111.     batch file will contain the commands required for the menu option selected.
  112. î                                                                        Page 3
  113.                       SETTING UP AUTOMENU FOR THE FIRST TIME
  114.  
  115.          To use this software for the first time requires knowledge of DOS and
  116.     a text editor.  The AUTOMENU.DAT file contains all the information needed
  117.     for the menu.  Before starting, determine what you plan to title your
  118.     menus, what menu options you wish to have, and the DOS commands required to
  119.     execute those options.  This information can then be listed in the menu
  120.     data file in the following sequence:
  121.  
  122.                 %TITLE OF MENU ONE
  123.                 *OPTION ONE OF MENU ONE
  124.                 +DOS COMMAND
  125.                 +DOS COMMAND
  126.                 *OPTION TWO OF MENU ONE
  127.                 +DOS COMMAND
  128.                 +DOS COMMAND
  129.                 %TITLE OF MENU TWO
  130.                 *OPTION ONE OF MENU TWO
  131.                 +DOS COMMAND
  132.                 *OPTION TWO OF MENU TWO
  133.                 +DOS COMMAND
  134.                 +DOS COMMAND
  135.                 #END OF MENU FILE
  136.  
  137.          The software determines the difference of the items listed in the menu
  138.     data file by the first character in each line.  These special characters
  139.     are listed below:
  140.                       %     percent sign     title
  141.                       *     star             option
  142.                       +     plus sign        dos command
  143.                       #     pound sign       end of file
  144.  
  145.          The maximum length for each line of information is 50 characters.  The
  146.     maximum number of menus that can be defined by one menu data file is eight,
  147.     with a maximum number of eight menu options per menu.  The number of DOS
  148.     commands that can be defined for an individual option is not limited.
  149.     However, the overall size of the menu data file is limited to 400 lines of
  150.     information.  Use the example below as a guide or the AUTOMENU.DAT file
  151.     that accompanied this software.
  152.  
  153.         Example contents of AUTOMENU.DAT
  154.        +---------------------------------+     This is the title of the menu
  155.        |%MY MAIN MENU                    |  <- marked by the percent sign.
  156.        |*Directory of Drive A:           |  <- This is a menu option marked
  157.        |+DIR A:                          |     by a star.
  158.        |+AUTO                            |  <- This is a DOS compatible
  159.        |*Format a Diskette in Drive A:   |     Command marked by a plus sign.
  160.        |+FORMAT A:                       |
  161.        |+AUTO                            |
  162.        |*Word Processing Menu            |  <- This menu option will change the
  163.        |+CHDIR \TEXT                     |     present directory to a TEXT sub
  164.        |+AUTO                            |     directory, and will load a
  165.        |*Copy Automenu.doc to printer    |     different AUTOMENU.DAT.
  166.        |+COPY AUTOMENU.DOC LPT1:         |
  167.        |+AUTO                            |
  168.        |*Return to Disk Operating System |
  169.        |+REM Welcome to DOS              |
  170.        |+REM Enter 'AUTO' for Menu       |
  171.        |#End of data for AUTOMENU        |  <- This marks the end of menu data
  172.        +---------------------------------+     file marked by a pound sign.
  173. î                                                                        Page 4
  174.  
  175.  
  176.                                 GETTING STARTED
  177.  
  178.     To run AUTOMENU follow the following steps:
  179.  
  180.          1.     Load a diskette with DOS and with the three files below:
  181.                       AUTO.BAT
  182.                       AUTOMENU.COM
  183.                       AUTOMENU.DAT
  184.  
  185.          2.     Enter the following command:
  186.  
  187.                       A>auto
  188.  
  189.          3.     The menu should then appear, ready for you to choose an
  190.                 option.
  191.  
  192.  
  193.                           FUNCTIONAL CHARACTERISTICS
  194.  
  195.          The menu options or menu items can be selected in various ways.  The
  196.     particular menu option with the arrow pointing to it can be selected by
  197.     pressing the return key.  The arrow pointer can be moved to another menu
  198.     option by using the up and down arrow keys.  A menu option can also be
  199.     selected by pressing the number value or FUNCTION KEY corresponding to that
  200.     menu option.  If more than one menu has been defined, the user can change
  201.     to the other menus by pressing F10 to go forward one menu and F9 to go
  202.     backwards one menu.  The user also has the ability to switch active
  203.     monitors from monochrome to color and back again by pressing the letter
  204.     "S".  However, this changing of active monitors will not occur if another
  205.     monitor is not available.  This utility also has a built in screen blackout
  206.     feature; if the machine remains inactive inside the menu for more than
  207.     three minutes, the screen will be turned off until the user presses a
  208.     character key on the keyboard.
  209.  
  210.          A list of the valid commands while in AUTOMENU:
  211.  
  212.                 1,2,3,4,5,6,7,8        Select option on menu
  213.                 F1,F2,F3,F4            Select option on menu
  214.                 F5,F6,F7,F8
  215.                 Up arrow               Move arrow pointer up
  216.                 Down arrow, space      Move arrow pointer down
  217.                 Return key             Select option being pointed to
  218.                 F10,PgUp,right arrow   Go to next menu
  219.                 F9,PgDn,left arrow     Go to previous menu
  220.                 Home                   First Menu
  221.                 End                    Last Menu
  222.                 S                      Switch active monitor (COLOR/MONO)
  223.                 C                      Print Copy Notice
  224.                 All other keys         Prints Help Message
  225. î                                                                        Page 5
  226.                    USES AND PERFORMANCE FOR FLOPPY DISK SYSTEMS
  227.  
  228.          On a floppy based system, a newly formatted disk should be used so
  229.     that the AUTOMENU's files are written together on the disk; this procedure
  230.     will increase the performance of AUTOMENU.
  231.  
  232.                    USES AND PERFORMANCE FOR FIXED DISK SYSTEMS
  233.  
  234.          On a fixed disk system, where the user may have several
  235.     sub-directories, AUTOMENU can provide an easy way to change to a different
  236.     directory and execute a program or load another AUTOMENU.DAT file with a
  237.     different set of menu options.  The DOS 2 command PATH works well within a
  238.     fixed disk environment and provides the user with the capability of being
  239.     able to execute most programs from any sub-directory.  A good example would
  240.     be to create a sub-directory called PUBLIC and within this sub-directory
  241.     place the programs and batch files commonly used; for example:  BASICA.COM,
  242.     DISKCOPY.COM, FORMAT.COM along with AUTOMENU.COM and AUTO.BAT.  In the
  243.     example section is a good example of an AUTOEXEC.BAT file to set-up your
  244.     fixed disk system.  Additions can be made to this batch file to handle RAM
  245.     Drives, clock cards, and any other initialization procedures.
  246.  
  247.                                 EXAMPLE SECTION
  248.  
  249.              Contents of AUTOEXEC.BAT             Contents of AUTO.BAT
  250.         +--------------------------------+ +--------------------------------+
  251.         |AUTO                            | |AUTOMENU                        |
  252.         +--------------------------------+ |AUTOTEMP                        |
  253.                                            +--------------------------------+
  254.        Example contents of AUTOEXEC.BAT good for fixed disk systems
  255.         +---------------------------+
  256.         |ECHO OFF                   |  <- Don't display commands that follow
  257.         |TIME                       |  <- Request present time
  258.         |DATE                       |  <- Request present date
  259.         |PROMPT $P $G               |  <- Prompt to show present sub-directory
  260.         |PATH=C:\PUBLIC             |  <- Path to sub-directory PUBLIC on C:
  261.         |VERIFY on                  |  <- Disk read after write check
  262.         |AUTO                       |  <- Execute AUTOMENU batch file
  263.         |REM autoexec.bat           |  <- Remark statement in batch file.
  264.         |REM by Marshall W. Magee   |
  265.         |REM on 11/02/83            |
  266.         +---------------------------+
  267.  
  268.                                ERROR MESSAGES
  269.  
  270.          There are three types of errors available with AUTOMENU.
  271.  
  272.             (1) Can't read "AUTOMENU.DAT" file
  273.                 This error occurs when the program cannot find or read that
  274.                 file.
  275.  
  276.             (2) Can't write "AUTOTEMP.BAT" file
  277.                 This error occurs when the program cannot write to disk or no
  278.                 space is left on disk to write file or disk is write protected.
  279.  
  280.             (3) Command error
  281.                 This error occurs when the user presses any key not defined by
  282.                 the program, and as a result the "MENU HELPS" will be
  283.                 displayed. These helps will then be removed on next valid
  284.                 command.
  285. î                                                                        Page 6
  286.                               CUSTOMIZATION
  287.  
  288.          With a patch, AUTOMENU can be set to display all items in black &
  289.     white or color.  The black & white option is good for computers with amber
  290.     screens, such as IBM Portable Computer.  The following sequence of commands
  291.     can perform this patch on AUTOMENU 2.0.
  292.  
  293.         +--------------------------------+
  294.         |A>debug automenu.com            | <- Run DOS's DEBUG on AUTOMENU
  295.         |-F 11C2 L1 2                    | <- Change value of Display mode to 2
  296.         |-W                              |        1 = Color
  297.         |Writing 1B9D Bytes              |        2 = Black & White
  298.         |-Q                              |
  299.         |A>                              | <- Returned to DOS
  300.         +--------------------------------+
  301.  
  302.          Other changes to customize AUTOMENU can be made to such areas as keys,
  303.     color of menus and messages, file names,and sound among others.  For more
  304.     information write a letter to the address listed on page one.
  305.  
  306.  
  307.                                 PROBLEMS
  308.  
  309.          If you have problems with AUTOMENU, please read this manual first to
  310.     make sure you do understand everything.  We have tried to provide a
  311.     problem-free product but sometimes we make mistakes.  If you think you have
  312.     found a problem please take the time to write us and explain your problem
  313.     to us.  Make sure that you include the following information to help us
  314.     evaluate the problem:
  315.  
  316.                 1.    Version of DOS used
  317.                 2.    Machine type, memory, monitors, etc.
  318.                 3.    Any application ran before AUTOMENU
  319.                 4.    Your address and phone number
  320.                 5.    Where and how you obtained AUTOMENU
  321.                 6.    Which version of AUTOMENU you have
  322.  
  323.  
  324.                            UPDATES AND CONCLUSION
  325.  
  326.          AUTOMENU is changing to respond to the request of its users.
  327.     Therefore if you wish to be kept aware of updates in AUTOMENU please send a
  328.     postcard and if updates are made, we will let you know.  This does not
  329.     require you to send a donation but it would help keep our development cost
  330.     down.  If you are not interested in updates, send a postcard anyway to let
  331.     us know who uses and likes AUTOMENU.  Also include information on where you
  332.     obtained this software.
  333.  
  334. ==============================================================================
  335. End of Documentation for AUTOMENU 2.0
  336. îî
  337.